FindAll(DocumentSpan[],String,String,FindCriteria,Boolean,Int32) Method

Finds all instances of textToFind in the specified document spans. Performs case-insensitive search by default.

Syntax

Visual Basic

'Declaration
 
Public Overloads Function FindAll( _
   ByVal spans() As DocumentSpan, _
   ByVal textToFind As String, _
   ByRef error As String, _
   Optional ByVal findCriteria As FindCriteria, _
   Optional ByVal allowOverlappingMatches As Boolean, _
   Optional ByVal maximumMatches As Integer _
) As FindResult

C#

public FindResult FindAll( 
   DocumentSpan[] spans,
   string textToFind,
   out string error,
   FindCriteria findCriteria,
   bool allowOverlappingMatches,
   int maximumMatches
)

Parameters

spans

The find operation will be restricted to content in these document spans.

textToFind

Text to find. This can be a wildcard as well by specifying findCriteria parameter with FindCriteria.Operator of FindOperator.Wildcard. Note that specifying null or empty string will return a FindResult object with 0 matches.

error

This will be set if an error occurs, such as when the 'textToFind' is indicated to be interpreted as a wild card but it's an invalid wildcard.

findCriteria

Used to specify whether it's a case sensitive search or whether to use wildcard matching.

allowOverlappingMatches

Indicates whether to find overlapping matches.

maximumMatches

Maximum number of matches to find.

Return Value

A FindResult object that contains a list of matches.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2